Skip to content

Document the three return shapes of PSSerializer.Deserialize #27889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Egor Sidorenko (esidorenko-sl) wants to merge 6 commits into
base: master
Choose a base branch
from
+9 −4
Open

Document the three return shapes of PSSerializer.Deserialize #27889

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c7397ec
Document the three return shapes of PSSerializer.Deserialize
esidorenko-sl Aug 26, 2026
8ce52bf
Potential fix for pull request finding
esidorenko-sl Aug 26, 2026
7e0b846
Fix the same typo in the DeserializeAsList doc comment
esidorenko-sl Aug 27, 2026
3f380f9
Merge branch 'master' into docs/psserializer-deserialize-return-shapes
esidorenko-sl Aug 27, 2026
eecdb86
Merge branch 'master' into docs/psserializer-deserialize-return-shapes
esidorenko-sl Aug 27, 2026
ba4a503
Merge branch 'master' into docs/psserializer-deserialize-return-shapes
esidorenko-sl Aug 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions src/System.Management.Automation/engine/serialization.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,13 @@ internal static string Serialize(IList<object> source, int depth, bool enumerate
/// <summary>
/// Deserializes PowerShell CliXml into an object.
/// </summary>
/// <param name="source">The CliXml the represents the object to deserialize.</param>
/// <returns>An object that represents the serialized content.</returns>
/// <param name="source">The CliXml that represents the object to deserialize.</param>
/// <returns>
/// The shape of the returned value depends on how many objects the CliXml contains:
/// <see langword="null"/> if it contains no objects, the single deserialized object if it
/// contains exactly one, or an <see cref="object"/> array if it contains more than one.
/// Use <see cref="DeserializeAsList(string)"/> instead if a consistent return type is needed.
/// </returns>
public static object Deserialize(string source)
{
object[] results = DeserializeAsList(source);
Expand All @@ -188,8 +193,8 @@ public static object Deserialize(string source)
/// <summary>
/// Deserializes PowerShell CliXml into a list of objects.
/// </summary>
/// <param name="source">The CliXml the represents the object to deserialize.</param>
/// <returns>An object array represents the serialized content.</returns>
/// <param name="source">The CliXml that represents the object to deserialize.</param>
/// <returns>An object array that represents the serialized content.</returns>
public static object[] DeserializeAsList(string source)
{
List<object> results = new List<object>();
Expand Down