diff options
| author | William Boman <william@redwill.se> | 2023-04-22 19:20:52 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-22 19:20:52 +0200 |
| commit | 579d4bd178f4aae76a4f4dc2ea34bf5e8fa6231b (patch) | |
| tree | ec3b23ec8a00ba1922bda6c7cf80a0c9242e1978 /doc | |
| parent | chore: remove generate scripts and artifacts (#1246) (diff) | |
| download | mason-579d4bd178f4aae76a4f4dc2ea34bf5e8fa6231b.tar mason-579d4bd178f4aae76a4f4dc2ea34bf5e8fa6231b.tar.gz mason-579d4bd178f4aae76a4f4dc2ea34bf5e8fa6231b.tar.bz2 mason-579d4bd178f4aae76a4f4dc2ea34bf5e8fa6231b.tar.lz mason-579d4bd178f4aae76a4f4dc2ea34bf5e8fa6231b.tar.xz mason-579d4bd178f4aae76a4f4dc2ea34bf5e8fa6231b.tar.zst mason-579d4bd178f4aae76a4f4dc2ea34bf5e8fa6231b.zip | |
feat(registry): add .get_all_package_specs() (#1247)
This is a faster method than .get_all_packages() due to the fact that it only loads package specifications without
instantiating mason-core.package instances. Useful for situations where one only needs to read spec data.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mason.txt | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/mason.txt b/doc/mason.txt index d29abaf4..c7fc564b 100644 --- a/doc/mason.txt +++ b/doc/mason.txt @@ -492,12 +492,20 @@ get_all_packages() *mason-registry.get_all_package_names()* get_all_package_names() - Returns all package names. This is a fast function that doesn't load any - extra modules. + Returns all package names. This is a faster function than + |mason-registry.get_all_packages()| because it loads fewer modules. Returns: string[] + *mason-registry.get_all_package_specs()* +get_all_package_specs() + Returns all package specifications. This is a faster function than + |mason-registry.get_all_packages()| because it loads fewer modules. + + Returns: + (PackageSpec | RegistryPackageSpec)[] + *mason-registry.update()* update({callback}) Updates all managed registries. |
