@dallaylaen/ski-interpreter 2.5.2 → 2.6.0

package/lib/types/expr.d.ts

@@ -679,35 +679,48 @@ export declare class Alias extends Named {
     /**
      * @desc A named alias for an existing expression.
      *
-     *     Upon evaluation, the alias expands into the original expression,
-     *     unless it has a known arity > 0 and is marked terminal,
-     *     in which case it waits for enough arguments before expanding.
+     * Aliasing allows declaring new terms without a native implementation.
+     * This is what happens when one writes `B = S(KS)K` in the interpreter.
+     *
+     * Aliases are transparent in terms of `equals` and `expect`;
+     * for that reason, Alias.diag() in not adding to the indentation.
+     *
+     * Aliases have an `inline` property. Tf true, the alias will be replaced with its implementation
+     * everywhere, unless specifically told otherwise e.g. by { inventory: { ... } } option of format().
+     *
+     * Upon creation, the aliases arity is calculated (unless `canonize` is false).
+     *
+     * Upon evaluation, the alias will be replaced with its implementation,
+     * _unless_ it's not inline and has positive arity,
+     * in which case it will wait for the required number of arguments before such replacement.
      *
-     *     A hidden mutable property 'outdated' is used to silently
-     *     replace the alias with its definition in all contexts.
-     *     This is used when declaring named terms in an interpreter,
-     *     to avoid confusion between old and new terms with the same name.
      *
      * @param {String} name
      * @param {Expr} impl
-     * @param {{canonize?: boolean, max?: number, maxArgs?: number, note?: string, terminal?: boolean}} [options]
+     * @param {{canonize?: boolean, max?: number, maxArgs?: number, note?: string, inline?: boolean}} [options]
      */
-    terminal?: boolean;
     impl: Expr;
-    outdated?: boolean;
+    inline?: boolean;
     constructor(name: string, impl: Expr, options?: {
         canonize?: boolean;
         max?: number;
         maxArgs?: number;
         note?: string;
-        terminal?: boolean;
-        outdated?: boolean;
+        inline?: boolean;
     });
     /**
-     * @property {boolean} [outdated] - whether the alias is outdated
-     *     and should be replaced with its definition when encountered.
-     * @property {boolean} [terminal] - whether the alias should behave like a standalone term
-     *     // TODO better name?
+     * @desc Make the alias inline, i.e. replace it with its implementation everywhere.
+     *
+     * Replaces the old `outdated` attribute.
+     * Used by the parser when a term definition is removed or updated.
+     *
+     * May change in future versions, use with caution.
+     *
+     * @experimental
+     * @returns {this}
+     */
+    makeInline(): this;
+    /**
      * @property {boolean} [proper] - whether the alias is a proper combinator (i.e. contains no free variables or constants)
      * @property {number} [arity] - the number of arguments the alias waits for before expanding
      * @property {Expr} [canonical] - equivalent lambda term.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dallaylaen/ski-interpreter",
-  "version": "2.5.2",
+  "version": "2.6.0",
   "description": "Simple Kombinator Interpreter - a combinatory logic & lambda calculus parser and interpreter. Supports SKI, BCKW, Church numerals, and setting up assertions ('quests') involving all of the above.",
   "keywords": [
     "combinatory logic",