libram 0.7.10 → 0.7.13

package/dist/combat.js

@@ -6,6 +6,7 @@ const MACRO_NAME = "Script Autoattack Macro";
 /**
  * Get the KoL native ID of the macro with name name.
  *
+ * @param name Name of the macro
  * @category Combat
  * @returns {number} The macro ID.
  */
@@ -20,11 +21,25 @@ export function getMacroId(name = MACRO_NAME) {
         return parseInt(macroMatches[0], 10);
     }
 }
+/**
+ * Converts an item name to a Item, or passes through an existing instance of Item
+ *
+ * @param itemOrName Item name or Item instance
+ * @returns KoLmafia Item instance
+ */
 function itemOrNameToItem(itemOrName) {
     return typeof itemOrName === "string" ? Item.get(itemOrName) : itemOrName;
 }
-const substringCombatItems = $items `spider web, really sticky spider web, dictionary, NG, Cloaca-Cola, yo-yo, top, ball, kite, yo, red potion, blue potion, adder, red button, pile of sand, mushroom, deluxe mushroom`;
-const substringCombatSkills = $skills `Shoot, Thrust-Smack, Headbutt, Toss, Sing, Disarm, LIGHT, BURN, Extract, Meteor Shower, Cleave, Boil, Slice, Rainbow`;
+// The list of all combat items whose name is a strict substring of another combat item
+const substringCombatItems = $items `spider web, really sticky spider web, dictionary, NG, Cloaca-Cola, yo-yo, top, ball, kite, yo, red potion, blue potion, bowling ball, adder, red button, pile of sand, mushroom, deluxe mushroom`;
+// The list of all combat skills whose name is a strict substring of another combat skill
+const substringCombatSkills = $skills `Shoot, Thrust-Smack, Headbutt, Toss, Sing, Disarm, LIGHT, BURN, Extract, Meteor Shower, Snipe, Cleave, Boil, Slice, Rainbow`;
+/**
+ * Create a string of the item or items provided that is compatible with BALLS syntax and is non-ambiguous
+ *
+ * @param itemOrItems Item name, item instance, or 2-tuple of item name or item instance
+ * @returns BALLS macro-compatible value for item or items provided
+ */
 function itemOrItemsBallsMacroName(itemOrItems) {
     if (Array.isArray(itemOrItems)) {
         return itemOrItems.map(itemOrItemsBallsMacroName).join(", ");
@@ -36,6 +51,12 @@ function itemOrItemsBallsMacroName(itemOrItems) {
             : toInt(item).toString();
     }
 }
+/**
+ * Generate a BALLS macro condition to check wither the player has either a single or a 2-tuple of combat items
+ *
+ * @param itemOrItems Single or 2-tuple of combat items
+ * @returns BALLS macro condition
+ */
 function itemOrItemsBallsMacroPredicate(itemOrItems) {
     if (Array.isArray(itemOrItems)) {
         return itemOrItems.map(itemOrItemsBallsMacroPredicate).join(" && ");
@@ -44,6 +65,12 @@ function itemOrItemsBallsMacroPredicate(itemOrItems) {
         return `hascombatitem ${itemOrItems}`;
     }
 }
+/**
+ * Converts a skill name to a Skill, or passes through an existing instance of Skill
+ *
+ * @param skillOrName Skill name or Skill instance
+ * @returns KoLmafia Skill instance
+ */
 function skillOrNameToSkill(skillOrName) {
     if (typeof skillOrName === "string") {
         return Skill.get(skillOrName);
@@ -52,6 +79,12 @@ function skillOrNameToSkill(skillOrName) {
         return skillOrName;
     }
 }
+/**
+ * Get a skill name in a form that is appropriate for BALLS macros
+ *
+ * @param skillOrName Skill name or Skill instance
+ * @returns BALLS macro-suitable skill name
+ */
 function skillBallsMacroName(skillOrName) {
     const skill = skillOrNameToSkill(skillOrName);
     return skill.name.match(/^[A-Za-z ]+$/) &&
@@ -76,19 +109,30 @@ export class Macro {
     name = MACRO_NAME;
     /**
      * Convert macro to string.
+     *
+     * @returns BALLS macro
      */
     toString() {
         return (this.components.join(";") + ";").replace(/;;+/g, ";");
     }
     /**
      * Gives your macro a new name to be used when saving an autoattack.
+     *
      * @param name The name to be used when saving as an autoattack.
-     * @returns The previous name assigned to this macro.
+     * @returns The macro in question
      */
     rename(name) {
-        const returnValue = this.name;
         this.name = name;
-        return returnValue;
+        return this;
+    }
+    /**
+     * Creates a new Macro with a name other than the default name.
+     *
+     * @param name The name to assign this macro.
+     * @returns A new Macro with the assigned name.
+     */
+    static rename(name) {
+        return new this().rename(name);
     }
     /**
      * Save a macro to a Mafia property for use in a consult script.
@@ -98,6 +142,8 @@ export class Macro {
     }
     /**
      * Load a saved macro from the Mafia property.
+     *
+     * @returns Loaded macro text
      */
     static load() {
         return new this().step(...get(Macro.SAVED_MACRO_PROPERTY).split(";"));
@@ -110,6 +156,7 @@ export class Macro {
     }
     /**
      * Statefully add one or several steps to a macro.
+     *
      * @param nextSteps The steps to add to the macro.
      * @returns {Macro} This object itself.
      */
@@ -120,6 +167,7 @@ export class Macro {
     }
     /**
      * Statefully add one or several steps to a macro.
+     *
      * @param nextSteps The steps to add to the macro.
      * @returns {Macro} This object itself.
      */
@@ -128,6 +176,8 @@ export class Macro {
     }
     /**
      * Submit the built macro to KoL. Only works inside combat.
+     *
+     * @returns Contents of the fight page after macro submission
      */
     submit() {
         const final = this.toString();
@@ -153,6 +203,7 @@ export class Macro {
     }
     /**
      * Renames the macro, then sets it as an autoattack.
+     *
      * @param name The name to save the macro under as an autoattack.
      */
     setAutoAttackAs(name) {
@@ -172,6 +223,7 @@ export class Macro {
     }
     /**
      * Add an "abort" step to this macro.
+     *
      * @returns {Macro} This object itself.
      */
     abort() {
@@ -179,6 +231,7 @@ export class Macro {
     }
     /**
      * Create a new macro with an "abort" step.
+     *
      * @returns {Macro} This object itself.
      */
     static abort() {
@@ -186,6 +239,7 @@ export class Macro {
     }
     /**
      * Add a "runaway" step to this macro.
+     *
      * @returns {Macro} This object itself.
      */
     runaway() {
@@ -193,6 +247,7 @@ export class Macro {
     }
     /**
      * Create a new macro with an "runaway" step.
+     *
      * @returns {Macro} This object itself.
      */
     static runaway() {
@@ -244,6 +299,7 @@ export class Macro {
     }
     /**
      * Add an "if" statement to this macro.
+     *
      * @param condition The BALLS condition for the if statement.
      * @param ifTrue Continuation if the condition is true.
      * @returns {Macro} This object itself.
@@ -255,6 +311,7 @@ export class Macro {
     }
     /**
      * Create a new macro with an "if" statement.
+     *
      * @param condition The BALLS condition for the if statement.
      * @param ifTrue Continuation if the condition is true.
      * @returns {Macro} This object itself.
@@ -264,6 +321,7 @@ export class Macro {
     }
     /**
      * Add an "if" statement to this macro, inverting the condition.
+     *
      * @param condition The BALLS condition for the if statement.
      * @param ifTrue Continuation if the condition is true.
      * @returns {Macro} This object itself.
@@ -275,6 +333,7 @@ export class Macro {
     }
     /**
      * Create a new macro with an "if" statement, inverting the condition.
+     *
      * @param condition The BALLS condition for the if statement.
      * @param ifTrue Continuation if the condition is true.
      * @returns {Macro} This object itself.
@@ -284,6 +343,7 @@ export class Macro {
     }
     /**
      * Add a "while" statement to this macro.
+     *
      * @param condition The BALLS condition for the if statement.
      * @param contents Loop to repeat while the condition is true.
      * @returns {Macro} This object itself.
@@ -293,6 +353,7 @@ export class Macro {
     }
     /**
      * Create a new macro with a "while" statement.
+     *
      * @param condition The BALLS condition for the if statement.
      * @param contents Loop to repeat while the condition is true.
      * @returns {Macro} This object itself.
@@ -302,6 +363,7 @@ export class Macro {
     }
     /**
      * Conditionally add a step to a macro based on a condition evaluated at the time of building the macro.
+     *
      * @param condition The JS condition.
      * @param ifTrue Continuation to add if the condition is true.
      * @param ifFalse Optional input to turn this into an if...else statement.
@@ -317,6 +379,7 @@ export class Macro {
     }
     /**
      * Create a new macro with a condition evaluated at the time of building the macro.
+     *
      * @param condition The JS condition.
      * @param ifTrue Continuation to add if the condition is true.
      * @param ifFalse Optional input to turn this into an if...else statement.
@@ -327,6 +390,7 @@ export class Macro {
     }
     /**
      * Add a repeat step to the macro.
+     *
      * @returns {Macro} This object itself.
      */
     repeat() {
@@ -334,6 +398,7 @@ export class Macro {
     }
     /**
      * Add one or more skill cast steps to the macro.
+     *
      * @param skills Skills to cast.
      * @returns {Macro} This object itself.
      */
@@ -344,6 +409,7 @@ export class Macro {
     }
     /**
      * Create a new macro with one or more skill cast steps.
+     *
      * @param skills Skills to cast.
      * @returns {Macro} This object itself.
      */
@@ -352,6 +418,7 @@ export class Macro {
     }
     /**
      * Add one or more skill cast steps to the macro, where each step checks if you have the skill first.
+     *
      * @param skills Skills to try casting.
      * @returns {Macro} This object itself.
      */
@@ -362,6 +429,7 @@ export class Macro {
     }
     /**
      * Create a new macro with one or more skill cast steps, where each step checks if you have the skill first.
+     *
      * @param skills Skills to try casting.
      * @returns {Macro} This object itself.
      */
@@ -370,6 +438,7 @@ export class Macro {
     }
     /**
      * Add one or more skill-cast-and-repeat steps to the macro, where each step checks if you have the skill first.
+     *
      * @param skills Skills to try repeatedly casting.
      * @returns {Macro} This object itself.
      */
@@ -380,6 +449,7 @@ export class Macro {
     }
     /**
      * Create a new macro with one or more skill-cast-and-repeat steps, where each step checks if you have the skill first.
+     *
      * @param skills Skills to try repeatedly casting.
      * @returns {Macro} This object itself.
      */
@@ -388,6 +458,7 @@ export class Macro {
     }
     /**
      * Add one or more item steps to the macro.
+     *
      * @param items Items to use. Pass a tuple [item1, item2] to funksling.
      * @returns {Macro} This object itself.
      */
@@ -398,6 +469,7 @@ export class Macro {
     }
     /**
      * Create a new macro with one or more item steps.
+     *
      * @param items Items to use. Pass a tuple [item1, item2] to funksling.
      * @returns {Macro} This object itself.
      */
@@ -406,6 +478,7 @@ export class Macro {
     }
     /**
      * Add one or more item steps to the macro, where each step checks to see if you have the item first.
+     *
      * @param items Items to try using. Pass a tuple [item1, item2] to funksling.
      * @returns {Macro} This object itself.
      */
@@ -416,6 +489,7 @@ export class Macro {
     }
     /**
      * Create a new macro with one or more item steps, where each step checks to see if you have the item first.
+     *
      * @param items Items to try using. Pass a tuple [item1, item2] to funksling.
      * @returns {Macro} This object itself.
      */
@@ -424,6 +498,7 @@ export class Macro {
     }
     /**
      * Add an attack step to the macro.
+     *
      * @returns {Macro} This object itself.
      */
     attack() {
@@ -431,6 +506,7 @@ export class Macro {
     }
     /**
      * Create a new macro with an attack step.
+     *
      * @returns {Macro} This object itself.
      */
     static attack() {
@@ -438,7 +514,9 @@ export class Macro {
     }
     /**
      * Create an if_ statement based on what holiday of loathing it currently is. On non-holidays, returns the original macro, unmutated.
+     *
      * @param macro The macro to place in the if_ statement
+     * @returns This macro with supplied macro wapped in if statement matching holiday wanderers
      */
     ifHolidayWanderer(macro) {
         const todaysWanderers = getTodaysHolidayWanderers();
@@ -448,14 +526,18 @@ export class Macro {
     }
     /**
      * Create a new macro starting with an ifHolidayWanderer step.
+     *
      * @param macro The macro to place inside the if_ statement
+     * @returns New macro with supplied macro wrapped in if statement matching holiday wanderers
      */
     static ifHolidayWanderer(macro) {
         return new this().ifHolidayWanderer(macro);
     }
     /**
      * Create an if_ statement based on what holiday of loathing it currently is. On non-holidays, returns the original macro, with the input macro appended.
+     *
      * @param macro The macro to place in the if_ statement.
+     * @returns This macro with supplied macro wrapped in if statement matching monsters that are not holiday wanderers
      */
     ifNotHolidayWanderer(macro) {
         const todaysWanderers = getTodaysHolidayWanderers();
@@ -465,7 +547,9 @@ export class Macro {
     }
     /**
      * Create a new macro starting with an ifNotHolidayWanderer step.
+     *
      * @param macro The macro to place inside the if_ statement
+     * @returns New macro with supplied macro wrapped in if statement matching monsters that are not holiday wanderers
      */
     static ifNotHolidayWanderer(macro) {
         return new this().ifNotHolidayWanderer(macro);
@@ -522,6 +606,7 @@ export function adventureMacroAuto(loc, autoMacro, nextMacro = null) {
 export class StrictMacro extends Macro {
     /**
      * Add one or more skill cast steps to the macro.
+     *
      * @param skills Skills to cast.
      * @returns {StrictMacro} This object itself.
      */
@@ -530,6 +615,7 @@ export class StrictMacro extends Macro {
     }
     /**
      * Create a new macro with one or more skill cast steps.
+     *
      * @param skills Skills to cast.
      * @returns {StrictMacro} This object itself.
      */
@@ -538,6 +624,7 @@ export class StrictMacro extends Macro {
     }
     /**
      * Add one or more item steps to the macro.
+     *
      * @param items Items to use. Pass a tuple [item1, item2] to funksling.
      * @returns {StrictMacro} This object itself.
      */
@@ -546,6 +633,7 @@ export class StrictMacro extends Macro {
     }
     /**
      * Create a new macro with one or more item steps.
+     *
      * @param items Items to use. Pass a tuple [item1, item2] to funksling.
      * @returns {StrictMacro} This object itself.
      */
@@ -554,6 +642,7 @@ export class StrictMacro extends Macro {
     }
     /**
      * Add one or more skill cast steps to the macro, where each step checks if you have the skill first.
+     *
      * @param skills Skills to try casting.
      * @returns {StrictMacro} This object itself.
      */
@@ -562,6 +651,7 @@ export class StrictMacro extends Macro {
     }
     /**
      * Create a new macro with one or more skill cast steps, where each step checks if you have the skill first.
+     *
      * @param skills Skills to try casting.
      * @returns {StrictMacro} This object itself.
      */
@@ -570,6 +660,7 @@ export class StrictMacro extends Macro {
     }
     /**
      * Add one or more item steps to the macro, where each step checks to see if you have the item first.
+     *
      * @param items Items to try using. Pass a tuple [item1, item2] to funksling.
      * @returns {StrictMacro} This object itself.
      */
@@ -578,6 +669,7 @@ export class StrictMacro extends Macro {
     }
     /**
      * Create a new macro with one or more item steps, where each step checks to see if you have the item first.
+     *
      * @param items Items to try using. Pass a tuple [item1, item2] to funksling.
      * @returns {StrictMacro} This object itself.
      */
@@ -586,6 +678,7 @@ export class StrictMacro extends Macro {
     }
     /**
      * Add one or more skill-cast-and-repeat steps to the macro, where each step checks if you have the skill first.
+     *
      * @param skills Skills to try repeatedly casting.
      * @returns {StrictMacro} This object itself.
      */
@@ -594,6 +687,7 @@ export class StrictMacro extends Macro {
     }
     /**
      * Create a new macro with one or more skill-cast-and-repeat steps, where each step checks if you have the skill first.
+     *
      * @param skills Skills to try repeatedly casting.
      * @returns {StrictMacro} This object itself.
      */

package/dist/counter.d.ts

@@ -1,17 +1,20 @@
 /**
  * Returns Infinity for counters that do not exist, and otherwise returns the duration of the counter
+ *
  * @param counter The name of the counter in question
  * @returns Infinity if the counter does not exist; otherwise returns the duration of the counter
  */
 export declare function get(counter: string): number;
 /**
  * The world is everything that is the case. This determines which counters are the case.
+ *
  * @param counter The name of the counter in question
  * @returns True for counters which currently exist; false for those which do not
  */
 export declare function exists(counter: string): boolean;
 /**
  * Creates a manual counter with specified name and duration
+ *
  * @param counter Name of the counter to manually create
  * @param duration Duration of counter to manually set
  * @returns Whether the counter was successfully set

package/dist/counter.js

@@ -1,6 +1,7 @@
 import { cliExecute, getCounter, getCounters } from "kolmafia";
 /**
  * Returns Infinity for counters that do not exist, and otherwise returns the duration of the counter
+ *
  * @param counter The name of the counter in question
  * @returns Infinity if the counter does not exist; otherwise returns the duration of the counter
  */
@@ -16,6 +17,7 @@ export function get(counter) {
 }
 /**
  * The world is everything that is the case. This determines which counters are the case.
+ *
  * @param counter The name of the counter in question
  * @returns True for counters which currently exist; false for those which do not
  */
@@ -24,6 +26,7 @@ export function exists(counter) {
 }
 /**
  * Creates a manual counter with specified name and duration
+ *
  * @param counter Name of the counter to manually create
  * @param duration Duration of counter to manually set
  * @returns Whether the counter was successfully set

package/dist/diet/index.d.ts

@@ -26,7 +26,9 @@ export declare class MenuItem<T> {
     static defaultOptions<T>(): Map<Item, MenuItemOptions<T>>;
     /**
      * Construct a new menu item, possibly with extra properties. Items in MenuItem.defaultOptions have intelligent defaults.
+     *
      * @param item Item to add to menu.
+     * @param options Options for this menu item
      * @param options.organ Designate item as belonging to a specific organ.
      * @param options.size Override item organ size. Necessary for any non-food/booze/spleen item.
      * @param options.maximum Maximum uses remaining today, or "auto" to check dailyusesleft Mafia property.

package/dist/diet/index.js

@@ -4,13 +4,20 @@ import { get as getModifier } from "../modifier";
 import { get } from "../property";
 import { Mayo, installed as mayoInstalled } from "../resources/2015/MayoClinic";
 import { $effect, $item, $items, $skill, $stat } from "../template-string";
-import { sum, sumNumbers } from "../utils";
+import { sum } from "../utils";
 import { knapsack } from "./knapsack";
 function isMonday() {
     // Checking Tuesday's ruby is a hack to see if it's Monday in Arizona.
     return getModifier("Muscle Percent", $item `Tuesday's ruby`) > 0;
 }
-// TODO: Include Salty Mouth and potentially other modifiers.
+/**
+ * Expected adventures from an item given a specified state
+ *
+ * @todo Include Salty Mouth and potentially other modifiers.
+ * @param item Item to consider
+ * @param modifiers Consumption modifiers to consider
+ * @returns Adventures expected
+ */
 function expectedAdventures(item, modifiers) {
     if (item.adventures === "")
         return 0;
@@ -118,7 +125,9 @@ export class MenuItem {
     }
     /**
      * Construct a new menu item, possibly with extra properties. Items in MenuItem.defaultOptions have intelligent defaults.
+     *
      * @param item Item to add to menu.
+     * @param options Options for this menu item
      * @param options.organ Designate item as belonging to a specific organ.
      * @param options.size Override item organ size. Necessary for any non-food/booze/spleen item.
      * @param options.maximum Maximum uses remaining today, or "auto" to check dailyusesleft Mafia property.
@@ -165,6 +174,10 @@ export class MenuItem {
     }
 }
 const organs = ["food", "booze", "spleen item"];
+/**
+ * @param x Name of thing that might be an organ
+ * @returns Whether the string supplied is the name of an organ
+ */
 function isOrgan(x) {
     return organs.includes(x);
 }
@@ -210,6 +223,7 @@ class DietPlanner {
     }
     /**
      * Determine the value of consuming a menu item with any profitable helpers.
+     *
      * @param menuItem Menu item to check.
      * @returns Value for consuming that menu item.
      */
@@ -218,6 +232,7 @@ class DietPlanner {
     }
     /**
      * Determine which helpers will be used with a menu item and its resulting value.
+     *
      * @param menuItem Menu item to check.
      * @param overrideModifiers Overrides for consumption modifiers, if any.
      * @returns Pair [array of helpers and base menu item, value].
@@ -285,6 +300,8 @@ class DietPlanner {
     }
     /**
      * Plan an individual organ.
+     *
+     * @param organ Organ to plan
      * @param capacity Organ capacity.
      * @param overrideModifiers Overrides for consumption modifiers, if any.
      * @returns Pair of [value, menu items and quantities].
@@ -300,6 +317,7 @@ class DietPlanner {
     }
     /**
      * Plan organs.
+     *
      * @param organCapacities Organ capacities.
      * @param overrideModifiers Overrides for consumption modifiers, if any.
      * @returns Pair of [value, menu items and quantities].
@@ -314,6 +332,7 @@ class DietPlanner {
     /**
      * Plan organs, retrying with and without each trial item. Runtime is
      * proportional to 2 ^ trialItems.length.
+     *
      * @param organCapacities Organ capacities.
      * @param trialItems Items to rerun solver with and without.
      * @param overrideModifiers Overrides for consumption modifiers, if any.
@@ -408,6 +427,7 @@ const interactingItems = [
 ];
 /**
  * Plan out an optimal diet using a knapsack algorithm.
+ *
  * @param mpa Meat per adventure value.
  * @param menu Array of MenuItems to consider for diet purposes.
  * @param organCapacities Optional override of each organ's capacity.
@@ -518,7 +538,7 @@ class DietEntry {
     expectedValue(mpa, diet, method = "gross") {
         const gross = mpa * this.expectedAdventures(diet) +
             this.quantity *
-                sumNumbers(this.menuItems.map((menuItem) => menuItem.additionalValue ?? 0));
+                sum(this.menuItems, (menuItem) => menuItem.additionalValue ?? 0);
         if (method === "gross") {
             return gross;
         }
@@ -527,8 +547,7 @@ class DietEntry {
         }
     }
     expectedPrice() {
-        return (this.quantity *
-            sumNumbers(this.menuItems.map((menuItem) => menuItem.price())));
+        return this.quantity * sum(this.menuItems, (menuItem) => menuItem.price());
     }
 }
 /**
@@ -559,13 +578,13 @@ export class Diet {
         return have($item `mafia pinky ring`) && canEquip($item `mafia pinky ring`);
     }
     expectedAdventures() {
-        return sumNumbers(this.entries.map((dietEntry) => dietEntry.expectedAdventures(this)));
+        return sum(this.entries, (dietEntry) => dietEntry.expectedAdventures(this));
     }
     expectedValue(mpa, method = "gross") {
-        return sumNumbers(this.entries.map((dietEntry) => dietEntry.expectedValue(mpa, this, method)));
+        return sum(this.entries, (dietEntry) => dietEntry.expectedValue(mpa, this, method));
     }
     expectedPrice() {
-        return sumNumbers(this.entries.map((dietEntry) => dietEntry.expectedPrice()));
+        return sum(this.entries, (dietEntry) => dietEntry.expectedPrice());
     }
     copy() {
         return new Diet([...this.entries]);

package/dist/diet/knapsack.d.ts

@@ -1,5 +1,6 @@
 /**
  * Solve the knapsack problem.
+ *
  * @param values Array of {[item, value, weight, maximum]} tuples for knapsack parameter.
  * @param capacity Capacity of knapsack.
  * @returns Tuple {[totalValue, items]} of selected items and total value of those items.

package/dist/diet/knapsack.js

@@ -5,8 +5,14 @@ class Not {
         this.thing = thing;
     }
 }
-// Assuming list is already sorted, count adjacent items.
-// Effectively run-length encoding.
+/**
+ * Assuming list is already sorted, count adjacent items.
+ * Effectively run-length encoding.
+ *
+ * @param list List to count
+ * @param isEqual Function that determines item equality
+ * @returns List of 2-tuples relating item to count
+ */
 function aggregate(list, isEqual) {
     const aggregatedList = [];
     for (const item of list) {
@@ -28,6 +34,7 @@ function aggregate(list, isEqual) {
 }
 /**
  * Solve the knapsack problem.
+ *
  * @param values Array of {[item, value, weight, maximum]} tuples for knapsack parameter.
  * @param capacity Capacity of knapsack.
  * @returns Tuple {[totalValue, items]} of selected items and total value of those items.
@@ -92,11 +99,12 @@ export function knapsack(values, capacity) {
 }
 /**
  * Find the best solution to a knapsack subproblem.
+ *
  * @param memoizationTable Memoization table for dynamic programming approach.
  * @param values Array of {[item, value, weight, maximum]} tuples for knapsack parameter.
  * @param currentIndex Current index into values array - only add items before this index.
  * @param remainingCapacity Remaining capacity of knapsack.
- * @returns
+ * @returns Tuple of value to item
  */
 function bestSolution(memoizationTable, values, currentIndex, remainingCapacity) {
     // If we've used all our capacity, this solution is no good.