Fix Dictionary.update type (#22)

Co-authored-by: cxmeel <[email protected]>

.vscode/settings.json

@@ -9,8 +9,8 @@
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
   "editor.codeActionsOnSave": {
-    "source.fixAll": true,
-    "source.organizeImports": true
+    "source.fixAll": "explicit",
+    "source.organizeImports": "explicit"
   },
   "editor.formatOnSave": true,
   "editor.formatOnPaste": true,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rbxts/sift",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "Immutable data library for Luau",
   "main": "out/init.lua",
   "types": "out/index.d.ts",
@@ -10,8 +10,7 @@
   "scripts": {
     "build": "rbxtsc --type=package --rojo=''",
     "watch": "rbxtsc -w",
-    "prepublishOnly": "npm run build",
-    "prepare": "husky install"
+    "prepublishOnly": "npm run build"
   },
   "repository": {
     "type": "git",
@@ -41,8 +40,7 @@
     "@rbxts/types": "^1.0.515",
     "rbxts-transform-debug": "^1.0.0-rc.1",
     "rbxts-transform-env": "^1.0.0-rc.0",
-    "typescript": "^4.3.5",
     "roblox-ts": "^1.2.7",
-    "husky": "^8.0.0"
+    "typescript": "^4.3.5"
   }
 }

src/Dictionary/update.lua

@@ -1,24 +1,15 @@
 --!strict
 local copy = require(script.Parent.copy)
 
-type Callback<K, V> = (key: K) -> V
-type Updater<K, V> = (value: V, key: K) -> V
-
-local function call<K, V>(callback: Callback<K, V>, key: K)
-	if type(callback) == "function" then
-		return callback(key)
-	end
-end
-
 --[=[
   @function update
   @within Dictionary
 
-  @param dictionary {[K]: V} -- The dictionary to update.
+  @param dictionary {[K]: V?} -- The dictionary to update.
   @param key K -- The key to update.
   @param updater? (value: V, key: K) -> U -- The updater function.
   @param callback? (key: K) -> C -- The callback function.
-  @return {[K]: V & U & C } -- The updated dictionary.
+  @return {[K]: V | U | C} -- The updated dictionary.
 
   Updates a value in a dictionary at the given key. If the value at the given key does not exist, `callback` will be called, and its return value will be used as the value at the given key.
 
@@ -37,20 +28,20 @@ end
   ```
 ]=]
 local function update<K, V, U, C>(
-	dictionary: { [K]: V },
+	dictionary: { [K]: V? },
 	key: K,
 	updater: ((value: V, key: K) -> U)?,
 	callback: ((key: K) -> C)?
-): { [K]: V & U & C }
-	local result = copy(dictionary)
+): { [K]: V | U | C }
+	local result: { [K]: any } = copy(dictionary)
 
-	if result[key] ~= nil then
+	if result[key] then
 		if updater then
 			result[key] = updater(result[key], key)
 		end
 	else
-		if callback then
-			result[key] = call(callback, key)
+		if typeof(callback) == "function" then
+			result[key] = callback(key)
 		end
 	end
 

wally.toml

@@ -1,12 +1,9 @@
 [package]
 name = "csqrl/sift"
 description = "Immutable data library for Luau"
-version = "0.0.8"
+version = "0.0.9"
 license = "MIT"
-author = "csqrl (https://csqrl.dev)"
 registry = "https://github.com/upliftgames/wally-index"
-homepage = "https://csqrl.github.io/sift"
-repo = "https://github.com/csqrl/sift"
 realm = "shared"
 exclude = ["**"]
 include = ["src", "src/**", "wally.toml", "wally.lock", "default.project.json"]