isaacscript-common 1.2.51 → 1.2.52

package/dist/types/DefaultMap.d.ts

@@ -0,0 +1,26 @@
+declare type FirstArg<K, V> = Iterable<[K, V]> | V | ((k: K) => V);
+declare type SecondArg<K, V> = V | ((k: K) => V);
+/**
+ * An extended Map with a new method of `getAndSetDefault`.
+ *
+ * When instantiating the object, you must specify either a default value or a function that returns
+ * a default value.
+ *
+ * Example:
+ * ```ts
+ * const defaultMap1 = new DefaultMap<string, string>("foo");
+ * const defaultMap2 = new DefaultMap<string, string>(["a", "b", "c"], "bar");
+ * ```
+ */
+export declare class DefaultMap<K, V> extends Map<K, V> {
+    private defaultValue;
+    private defaultValueFactory;
+    constructor(iterableOrDefaultValueOrDefaultValueFactory: FirstArg<K, V>, defaultValueOrDefaultValueFactory?: SecondArg<K, V>);
+    /**
+     * Almost the same as `Map.prototype.get`. However, if the key does not exist in the map, then
+     * this method will set the default value for the key and return the default value.
+     */
+    getAndSetDefault(key: K): V | undefined;
+    getDefaultValue(key: K): V;
+}
+export {};

package/dist/types/DefaultMap.lua

@@ -0,0 +1,67 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local Map = ____lualib.Map
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local ____exports = {}
+local parseArguments, parseArgumentsOne, parseArgumentsTwo, parseDefaultValueOrDefaultValueFactory
+function parseArguments(self, firstArg, secondArg)
+    return secondArg == nil and parseArgumentsOne(nil, firstArg) or parseArgumentsTwo(nil, firstArg, secondArg)
+end
+function parseArgumentsOne(self, firstArg)
+    local defaultValue, defaultValueFactory = table.unpack(parseDefaultValueOrDefaultValueFactory(nil, firstArg))
+    return {nil, defaultValue, defaultValueFactory}
+end
+function parseArgumentsTwo(self, firstArg, secondArg)
+    local firstArgType = type(firstArg)
+    if firstArgType ~= "table" then
+        error("A DefaultMap constructor with two arguments must have the first argument be an array.")
+    end
+    local defaultValue, defaultValueFactory = table.unpack(parseDefaultValueOrDefaultValueFactory(nil, secondArg))
+    return {firstArg, defaultValue, defaultValueFactory}
+end
+function parseDefaultValueOrDefaultValueFactory(self, arg)
+    local argType = type(arg)
+    if argType == "function" then
+        return {nil, arg}
+    end
+    if argType == "boolean" or argType == "number" or argType == "string" then
+        return {arg, nil}
+    end
+    return error("A DefaultMap must be initialized with a default value that is either a primitive or a function that returns a default value.")
+end
+____exports.DefaultMap = __TS__Class()
+local DefaultMap = ____exports.DefaultMap
+DefaultMap.name = "DefaultMap"
+__TS__ClassExtends(DefaultMap, Map)
+function DefaultMap.prototype.____constructor(self, iterableOrDefaultValueOrDefaultValueFactory, defaultValueOrDefaultValueFactory)
+    local iterable, defaultValue, defaultValueFactory = table.unpack(parseArguments(nil, iterableOrDefaultValueOrDefaultValueFactory, defaultValueOrDefaultValueFactory))
+    if defaultValue == nil and defaultValueFactory == nil then
+        error("A DefaultMap must be instantiated with either a default value or a function that returns a default value.")
+    end
+    if iterable == nil then
+        Map.prototype.____constructor(self)
+    else
+        Map.prototype.____constructor(self, iterable)
+    end
+    self.defaultValue = defaultValue
+    self.defaultValueFactory = defaultValueFactory
+end
+function DefaultMap.prototype.getAndSetDefault(self, key)
+    if self:has(key) then
+        return self:get(key)
+    end
+    local defaultValue = self:getDefaultValue(key)
+    self:set(key, defaultValue)
+    return defaultValue
+end
+function DefaultMap.prototype.getDefaultValue(self, key)
+    if self.defaultValue ~= nil then
+        return self.defaultValue
+    end
+    if self.defaultValueFactory ~= nil then
+        return self:defaultValueFactory(key)
+    end
+    return error("A DefaultMap was incorrectly instantiated.")
+end
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.51",
+  "version": "1.2.52",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",