clarify Items export use

overextended · Jun 1, 2024 · 57e8844 · 57e8844
1 parent 5afdb36
commit 57e8844
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/pages/ox_inventory/Functions/Client.mdx b/pages/ox_inventory/Functions/Client.mdx
@@ -85,10 +85,14 @@ exports.ox_inventory:closeInventory()
 
 Returns a table of all registered items. The format is as defined in [data/items.lua](https://github.com/overextended/ox_inventory/blob/main/data/items.lua).
 
+Optionally takes the name of an item, returning only data for that item (getting all data is not recommended).
+
 ```lua
-exports.ox_inventory:Items()
+exports.ox_inventory:Items(itemName)
 ```
 
+- itemName?: `string`
+
 The following snippet can be used in crafting resources such as okokCrafting or core_crafting, rather than retrieving information from the server.
 
 ```lua

diff --git a/pages/ox_inventory/Functions/Server.mdx b/pages/ox_inventory/Functions/Server.mdx
@@ -88,10 +88,14 @@ exports.ox_inventory:UpdateVehicle(oldPlate, newPlate)
 
 Returns a table of all registered items. The format is as defined in [data/items.lua](https://github.com/overextended/ox_inventory/blob/main/data/items.lua).
 
+Optionally takes the name of an item, returning only data for that item (getting all data is not recommended).
+
 ```lua
-exports.ox_inventory:Items()
+exports.ox_inventory:Items(itemName)
 ```
 
+- itemName?: `string`
+
 The following snippet can be used in crafting resources such as okokCrafting or core_crafting, rather than querying the database.
 
 ```lua