Skip to content

Add an -AsArray switch to ConvertTo-Json to support unconditional conversion to a JSON array #6327

Closed
Closed
Add an -AsArray switch to ConvertTo-Json to support unconditional conversion to a JSON array#6327
Assignees
kalgiz
Labels
Issue-Enhancementthe issue is more of a feature request than a bugResolution-FixedThe issue is fixed.WG-Cmdletsgeneral cmdlet issues
Milestone
6.1.0-Consider

Description

@mklement0
Michael Klement (mklement0)
opened on Mar 6, 2018

Based on a suggestion by @AikenBM, welcomed by Steve Lee (@SteveL-MSFT):

Similar to how @(...) ensures treatment of any value as an array, it would be handy if an -AsArray switch could instruct ConvertTo-Json to treat its input as an [ultimately JSON] array, so you can guarantee that your pipeline input is treated as an array, even if it happens to be a single item only:

Wishful thinking:

> $in = 1; $in | ConvertTo-Json -AsArray
[ 
  1 
] 
# scalar 1 was treated as an array

> $in = 1, 2; $in | ConvertTo-Json -AsArray
[ 
  1, 
  2 
]  
# Input that already is an array is left as-is

Awkward workaround, in the absence of -AsArray:

> $in = 1; , @($in) | ConvertTo-Json -AsArray
[ 
  1 
]

Environment data

Written as of PowerShell Core v6.0.1

Activity

  1. Michael Klement (mklement0)
    changed the title [-]Add switch `-AsArray` to ConvertTo-Json to support unconditional conversion as an array[/-] [+]Add an -AsArray switch to ConvertTo-Json to support unconditional conversion to a JSON array[/+] on Mar 6, 2018
  2. Steve Lee (SteveL-MSFT)
    added
    Issue-Enhancementthe issue is more of a feature request than a bug
    Area-Cmdlets-Utility
    on Mar 8, 2018
  3. Steve Lee (SteveL-MSFT)
    added this to the 6.1.0-Consider milestone on Mar 8, 2018
  4. Steve Lee (SteveL-MSFT)
    added
    Up-for-GrabsUp-for-grabs issues are not high priorities, and may be opportunities for external contributors
    on Mar 8, 2018
  5. Klaudia Algiz (kalgiz)
    self-assigned this
    on Mar 19, 2018

  6. kalgiz commented on Mar 20, 2018

    @kalgiz
    Klaudia Algiz (kalgiz)
    on Mar 20, 2018
    Contributor

    Fix proposal in #6438.

  7. Steve Lee (SteveL-MSFT)
    removed
    Up-for-GrabsUp-for-grabs issues are not high priorities, and may be opportunities for external contributors
    on Mar 20, 2018

  8. kalgiz commented on Mar 23, 2018

    @kalgiz
    Klaudia Algiz (kalgiz)
    on Mar 23, 2018
    Contributor

    Fixed in #6438.

  9. Klaudia Algiz (kalgiz)
    closed this as completedon Mar 23, 2018
  10. Ilya (iSazonov)
    added
    Resolution-FixedThe issue is fixed.
    on Mar 24, 2018
  11. Ryan Yates (kilasuit)
    added
    WG-Cmdletsgeneral cmdlet issues
    and removed
    WG-Cmdlets-Utility
    on Jul 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Issue-Enhancementthe issue is more of a feature request than a bugResolution-FixedThe issue is fixed.WG-Cmdletsgeneral cmdlet issues

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions