Add PlayersData:tryRun() function (#8)

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
+- add `tryRun` method to PlayersData ([#8](https://github.com/seaofvoices/luau-disk/pull/8))
+
 ## 0.1.0
 
 - Initial version

README.md

@@ -83,6 +83,18 @@ Attempts to retrieve the data associated with a specific player.
 - **Returns:**
   - `Data`: The player's data if available, or `nil` if not found.
 
+#### `tryRun<Data>(player: Player, fn: (Data) -> ()): boolean`
+
+Execute the given `fn` function only if data is found for the given `Player`.
+
+- **Parameters:**
+
+  - `player`: The player for whom data is to be retrieved.
+  - `fn`: A function that accepts the data associated with the player.
+
+- **Returns:**
+  - `boolean`: If the `fn` function was called or not.
+
 #### `expect<Data>(player: Player): Data`
 
 Retrieves the data associated with a specific player and raises an error if the data is not available.

src/impl/PlayersData.lua

@@ -1,5 +1,6 @@
 export type PlayersData<Data> = {
     tryGet: (self: PlayersData<Data>, player: Player) -> Data?,
+    tryRun: (self: PlayersData<Data>, player: Player, fn: (Data) -> ()) -> boolean,
     expect: (self: PlayersData<Data>, player: Player) -> Data,
     restoreDefault: (self: PlayersData<Data>, player: Player) -> (),
 }
@@ -12,6 +13,7 @@ type PlayersDataStatic = {
     new: <Data>(data: { [Player]: Data }, getDefault: () -> Data) -> PlayersData<Data>,
 
     tryGet: <Data>(self: PlayersData<Data>, player: Player) -> Data?,
+    tryRun: <Data>(self: PlayersData<Data>, player: Player, fn: (Data) -> ()) -> boolean,
     expect: <Data>(self: PlayersData<Data>, player: Player) -> Data,
     restoreDefault: <Data>(self: PlayersData<Data>, player: Player) -> (),
 }
@@ -37,6 +39,18 @@ function PlayersData:tryGet<Data>(player: Player): Data?
     return self._data[player]
 end
 
+function PlayersData:tryRun<Data>(player: Player, fn: (Data) -> ()): boolean
+    local self: PrivatePlayersData<Data> = self :: any
+
+    local data = self._data[player]
+    if data ~= nil then
+        fn(data)
+        return true
+    end
+
+    return false
+end
+
 function PlayersData:expect<Data>(player: Player): Data
     local self: PrivatePlayersData<Data> = self :: any