Missing docs or link to PSRepositoryItemInfo

[boernsen-development]

Prerequisites

• Existing Issue: Search the existing issues for this repository. If there is an issue that fits your needs do not file a new one. Subscribe, react, or comment on that issue instead.
• Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Typo in Get-Foo cmdlet" instead of "Typo."
• Verify Version: If there is a mismatch between documentation and the module on your system, ensure that the version you are using is the same as the documentation. Check this box if they match or the issue you are reporting is not version specific.

Version

PowerShellGet v3/PSResourceGet
PowerShellGet v2
PowerShellGet v1

Links

https://github.com/MicrosoftDocs/PowerShell-Docs-PSGet/blob/main/powershell-gallery/powershellget-3.x/PowerShellGet/Find-Module.md

Probably more

Summary

I came across the documentation of Find-Module and it refers to a PSRepositoryItemInfo object, but I can't find any information about it, not even by searching online.

Could this be clarified or linked?

This probably also applies to other related function's docs.

Suggested Fix

Add link to the docs or at least to the code of PSRepositoryItemInfo.

[sdwheeler]

The Microsoft.PowerShell.Commands.PSRepositoryItemInfo type isn't documented anywhere. It is a PSCustomObject created in the PowerShellGet script module. Like any object instance, you can view the type information using Get-Member.

PS> $module = Find-Module -Name Pester -AllowPrerelease
PS> $module.PSTypeNames

Microsoft.PowerShell.Commands.PSRepositoryItemInfo
System.Management.Automation.PSCustomObject
System.Object

PS> $module | Get-Member

   TypeName: Microsoft.PowerShell.Commands.PSRepositoryItemInfo

Name                       MemberType   Definition
----                       ----------   ----------
Equals                     Method       bool Equals(System.Object obj)
GetHashCode                Method       int GetHashCode()
GetType                    Method       type GetType()
ToString                   Method       string ToString()
AdditionalMetadata         NoteProperty System.Management.Automation.PSCustomObject AdditionalMetadata=@{summary=Peste…
Author                     NoteProperty string Author=Pester Team
CompanyName                NoteProperty Object[] CompanyName=System.Object[]
Copyright                  NoteProperty string Copyright=Copyright (c) 2024 by Pester Team, licensed under Apache 2.0 …
Dependencies               NoteProperty Object[] Dependencies=System.Object[]
Description                NoteProperty string Description=Pester provides a framework for running BDD style Tests to …
IconUri                    NoteProperty uri IconUri=https://raw.githubusercontent.com/pester/Pester/main/images/pester…
Includes                   NoteProperty hashtable Includes=System.Collections.Hashtable
InstalledDate              NoteProperty object InstalledDate=null
LicenseUri                 NoteProperty uri LicenseUri=https://www.apache.org/licenses/LICENSE-2.0.html
Name                       NoteProperty string Name=Pester
PackageManagementProvider  NoteProperty string PackageManagementProvider=NuGet
PowerShellGetFormatVersion NoteProperty object PowerShellGetFormatVersion=null
ProjectUri                 NoteProperty uri ProjectUri=https://github.com/Pester/Pester
PublishedDate              NoteProperty datetime PublishedDate=10/30/2024 9:49:57 PM
ReleaseNotes               NoteProperty string ReleaseNotes=https://github.com/pester/Pester/releases/tag/6.0.0-alpha5
Repository                 NoteProperty string Repository=PSGallery
RepositorySourceLocation   NoteProperty string RepositorySourceLocation=https://www.powershellgallery.com/api/v2
Tags                       NoteProperty Object[] Tags=System.Object[]
Type                       NoteProperty string Type=Module
UpdatedDate                NoteProperty object UpdatedDate=null
Version                    NoteProperty string Version=6.0.0-alpha5