From 7000c22f660bcd407361fec5cef29a4f0b7edeaa Mon Sep 17 00:00:00 2001
From: William Boman <william@redwill.se>
Date: Fri, 15 Jul 2022 02:06:38 +0200
Subject: docs: add doc/reference.md for more advanced use cases (#75)

---
 lua/mason-registry/init.lua | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'lua/mason-registry/init.lua')

diff --git a/lua/mason-registry/init.lua b/lua/mason-registry/init.lua
index 97509d68..ed56512c 100644
--- a/lua/mason-registry/init.lua
+++ b/lua/mason-registry/init.lua
@@ -49,11 +49,15 @@ do
     end
 end
 
+---Checks whether the provided package name is installed.
+---In many situations, this is a more efficient option than the Package:is_installed() method due to a smaller amount of
+---modules required to load.
 ---@param package_name string
 function M.is_installed(package_name)
     return scan_install_root()[package_name] == true
 end
 
+---Returns an instance of the Package class if the provided package name exists. This function errors if a package cannot be found.
 ---@param package_name string
 ---@return Package
 function M.get_package(package_name)
@@ -67,21 +71,25 @@ end
 
 local get_packages = _.map(M.get_package)
 
+---Returns all installed package names. This is a fast function that doesn't load any extra modules.
 ---@return string[]
 function M.get_installed_package_names()
     return _.keys(scan_install_root())
 end
 
+---Returns all installed package instances. This is a slower function that loads more modules.
 ---@return Package[]
 function M.get_installed_packages()
     return get_packages(M.get_installed_package_names())
 end
 
+---Returns all package names. This is a fast function that doesn't load any extra modules.
 ---@return string[]
 function M.get_all_package_names()
     return _.keys(index)
 end
 
+---Returns all package instances. This is a slower function that loads more modules.
 ---@return Package[]
 function M.get_all_packages()
     return get_packages(M.get_all_package_names())
-- 
cgit v1.2.3-70-g09d2