continuedfraction.js 0.0.1 → 0.0.2

package/README.md

@@ -75,27 +75,37 @@ Import the static utility class and use its generators and evaluator:
 const sqrtGen = ContinuedFraction.sqrt(23);
 console.log(sqrtGen.next().value); // 4
 console.log(sqrtGen.next().value); // 1, 3, 1, 8, …
+````
 
+```javascript
 // 2) Continued‑fraction of a decimal
 let cnt = 0;
 for (let piCf of ContinuedFraction.fromNumber(Math.PI)) {
   console.log(piCf);
   if (cnt++ >= 10) break;
 }
+````
 
+```javascript
 // 3) Golden ratio φ terms
 const phiGen = ContinuedFraction.PHI();
 console.log(phiGen.next().value); // 1, and forever 1…
+````
 
+```javascript
 // 4) Evaluate the first 10 terms of e’s CF to a Fraction
 const approxE = ContinuedFraction.eval(ContinuedFraction.E, 10);
 console.log(approxE.toString()); // e ≈ “193/71”
+````
 
+```javascript
 // 5) Generalized CF for π, 4/π
 const genPi = ContinuedFraction.PI();
 console.log(genPi.next().value);   // { a: 3, b: 0 }
 console.log(genPi.next().value);   // { a: 6, b: 1 }
+````
 
+```javascript
 // 6) Continued‑fraction from two integers
 const halfCf = ContinuedFraction.fromFraction(1, 2);
 console.log([...halfCf]); // [0, 2]
@@ -112,7 +122,7 @@ console.log([...halfCf]); // [0, 2]
 | `FOUR_OVER_PI()`         | `Generator<CFTerm>`                                               | Generalized CF terms for 4/π                                            |
 | `PI()`                   | `Generator<CFTerm>`                                               | Generalized CF terms for π                                              |
 | `E()`                    | `Generator<number>`                                               | CF expansion of e                                                       |
-| `eval(generator, steps)` | `(Generator|() => Generator, steps?: number) ⇒ Fraction`          | Evaluate (generalized) continued fraction to a `Fraction` approximation |
+| `eval(generator, steps)` | `Generator (() => Generator, steps?: number) ⇒ Fraction`          | Evaluate (generalized) continued fraction to a `Fraction` approximation |
 
 ## Coding Style
 

package/continuedfraction.d.mts

@@ -0,0 +1,69 @@
+import type Fraction from 'fraction.js';
+
+/**
+ * A term of a generalized continued fraction.
+ */
+export interface CFTerm {
+    /** The aₙ coefficient */
+    a: number;
+    /** The bₙ coefficient */
+    b: number;
+}
+
+/**
+ * Utility class for generating continued-fraction expansions of various constants.
+ * All methods are static.
+ */
+declare class ContinuedFraction {
+    /**
+     * Infinite generator for the continued‐fraction terms of √N.
+     * @param N Integer whose square‐root CF expansion is desired (N ≥ 0)
+     * @yields Next continued‐fraction term of √N
+     */
+    static sqrt(N: number): Generator<number, void, unknown>;
+
+    /**
+     * Generator for continued‐fraction terms of any real number via Fraction.js.
+     * @param n The real number to convert (as number, string, or bigint)
+     * @yields Next continued‐fraction term of n
+     */
+    static fromNumber(n: number | string | bigint): Generator<number, void, unknown>;
+
+    /**
+     * Generator for continued‐fraction terms of a rational a/b via Fraction.js.
+     * @param a Numerator (number, string, bigint, or Fraction)
+     * @param b Denominator (number, string, or bigint)
+     * @yields Next continued‐fraction term of a/b
+     */
+    static fromFraction(
+        a: number | string | bigint | Fraction,
+        b: number | string | bigint
+    ): Generator<number, void, unknown>;
+
+    /** Infinite generator of the golden ratio φ = [1; 1, 1, 1, …]. */
+    static PHI(): Generator<number, void, unknown>;
+
+    /** Infinite generator for the generalized continued‐fraction terms of 4/π. */
+    static FOUR_OVER_PI(): Generator<CFTerm, void, unknown>;
+
+    /** Infinite generator for the generalized continued‐fraction terms of π. */
+    static PI(): Generator<CFTerm, void, unknown>;
+
+    /** Infinite generator of e = [2; 1, 2, 1, 1, 4, 1, …]. */
+    static E(): Generator<number, void, unknown>;
+
+    /**
+     * Evaluate a (simple or generalized) continued fraction generator.
+     * @param generator A CF term generator or a function returning one
+     * @param steps Number of terms to include (default 10)
+     * @returns Rational approximation as a Fraction
+     */
+    static eval(
+        generator:
+            | Generator<number | CFTerm, any, any>
+            | (() => Generator<number | CFTerm, any, any>),
+        steps?: number
+    ): Fraction;
+}
+
+export { ContinuedFraction as default, ContinuedFraction };

package/continuedfraction.d.ts

@@ -1,26 +1,6 @@
+import Fraction = require('fraction.js');
 
-import type Fraction from 'fraction.js';
-
-/**
- * A term of a generalized continued fraction.
- */
-export interface CFTerm {
-    /** The aₙ coefficient */
-    a: number;
-    /** The bₙ coefficient */
-    b: number;
-}
-
-/**
- * Utility class for generating continued-fraction expansions of various constants.
- * All methods are static.
- */
-export default class ContinuedFraction {
-    /**
-     * Infinite generator for the continued‐fraction terms of √N.
-     * @param N Integer whose square‐root CF expansion is desired (N ≥ 0)
-     * @yields Next continued‐fraction term of √N
-     */
+declare class ContinuedFraction {
     static sqrt(N: number): Generator<number, void, unknown>;
 
     /**
@@ -41,28 +21,16 @@ export default class ContinuedFraction {
         b: number | string | bigint
     ): Generator<number, void, unknown>;
 
-    /**
-     * Infinite generator of the golden ratio φ = [1; 1, 1, 1, …].
-     * @yields Always 1
-     */
+    /** Infinite generator of the golden ratio φ = [1; 1, 1, 1, …]. */
     static PHI(): Generator<number, void, unknown>;
 
-    /**
-     * Infinite generator for the generalized continued‐fraction terms of 4/π.
-     * @yields Term pairs { a, b } for the continued‐fraction
-     */
-    static FOUR_OVER_PI(): Generator<CFTerm, void, unknown>;
+    /** Infinite generator for the generalized continued‐fraction terms of 4/π. */
+    static FOUR_OVER_PI(): Generator<ContinuedFraction.CFTerm, void, unknown>;
 
-    /**
-     * Infinite generator for the generalized continued‐fraction terms of π.
-     * @yields Term pairs { a, b } for the continued‐fraction
-     */
-    static PI(): Generator<CFTerm, void, unknown>;
+    /** Infinite generator for the generalized continued‐fraction terms of π. */
+    static PI(): Generator<ContinuedFraction.CFTerm, void, unknown>;
 
-    /**
-     * Infinite generator of e = [2; 1, 2, 1, 1, 4, 1, …].
-     * @yields Next continued‐fraction term of e
-     */
+    /** Infinite generator of e = [2; 1, 2, 1, 1, 4, 1, …]. */
     static E(): Generator<number, void, unknown>;
 
     /**
@@ -73,8 +41,22 @@ export default class ContinuedFraction {
      */
     static eval(
         generator:
-            | Generator<number | CFTerm, any, any>
-            | (() => Generator<number | CFTerm, any, any>),
+            | Generator<number | ContinuedFraction.CFTerm, any, any>
+            | (() => Generator<number | ContinuedFraction.CFTerm, any, any>),
         steps?: number
     ): Fraction;
 }
+
+declare namespace ContinuedFraction {
+    /**
+     * A term of a generalized continued fraction.
+     */
+    interface CFTerm {
+        /** The aₙ coefficient */
+        a: number;
+        /** The bₙ coefficient */
+        b: number;
+    }
+}
+
+export = ContinuedFraction;

package/dist/continuedfraction.min.js

@@ -1,5 +1,5 @@
 /*
-ContinuedFraction.js v0.0.1 4/18/2025
+ContinuedFraction.js v0.0.2 8/16/2025
 https://github.com/rawify/ContinuedFraction.js
 
 Copyright (c) 2025, Robert Eisele (https://raw.org/)

package/package.json

@@ -1,10 +1,10 @@
 {
     "name": "continuedfraction.js",
     "title": "ContinuedFraction.js",
-    "version": "0.0.1",
+    "version": "0.0.2",
+    "description": "The RAW continued fractions library",
     "homepage": "https://github.com/rawify/ContinuedFraction.js",
     "bugs": "https://github.com/rawify/ContinuedFraction.js/issues",
-    "description": "The RAW continued fractions library",
     "keywords": [
         "math",
         "continued fraction",
@@ -14,20 +14,41 @@
     "private": false,
     "main": "./dist/continuedfraction.js",
     "module": "./dist/continuedfraction.mjs",
-    "types": "./continuedfraction.d.ts",
     "browser": "./dist/continuedfraction.min.js",
     "unpkg": "./dist/continuedfraction.min.js",
-    "readmeFilename": "README.md",
+    "types": "./continuedfraction.d.ts",
     "exports": {
         ".": {
-            "types": "./continuedfraction.d.ts",
-            "require": "./dist/continuedfraction.js",
-            "import": "./dist/continuedfraction.mjs"
+            "import": {
+                "types": "./continuedfraction.d.mts",
+                "default": "./dist/continuedfraction.mjs"
+            },
+            "require": {
+                "types": "./continuedfraction.d.ts",
+                "default": "./dist/continuedfraction.js"
+            },
+            "browser": {
+                "types": "./continuedfraction.d.ts",
+                "default": "./dist/continuedfraction.min.js"
+            },
+            "default": {
+                "types": "./continuedfraction.d.ts",
+                "default": "./dist/continuedfraction.js"
+            }
+        },
+        "./package.json": "./package.json"
+    },
+    "typesVersions": {
+        "<4.7": {
+            "*": [
+                "continuedfraction.d.ts"
+            ]
         }
     },
+    "sideEffects": false,
     "repository": {
         "type": "git",
-        "url": "git@github.com:rawify/ContinuedFraction.js.git"
+        "url": "git+ssh://git@github.com/rawify/ContinuedFraction.js.git"
     },
     "funding": {
         "type": "github",
@@ -50,8 +71,8 @@
         "test": "mocha tests/*.js"
     },
     "devDependencies": {
-        "crude-build": "^0.1.0",
-        "mocha": "^11.1.0"
+        "crude-build": "^0.1.2",
+        "mocha": "^11.7.1"
     },
     "dependencies": {
         "fraction.js": "^5.2.2"

package/src/continuedfraction.js

@@ -1,5 +1,5 @@
 /**
- * @license ContinuedFraction.js v0.0.1 4/18/2025
+ * @license ContinuedFraction.js v0.0.2 8/16/2025
  * https://github.com/rawify/ContinuedFraction.js
  *
  * Copyright (c) 2025, Robert Eisele (https://raw.org/)