Skip to content

Commit

Permalink
feat: Out-JSON ( Fixes #727 )
Browse files Browse the repository at this point in the history
Adding Example
  • Loading branch information
StartAutomating authored and StartAutomating committed Mar 9, 2024
1 parent 530a563 commit 457064f
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions docs/Out-JSON.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
Out-JSON
--------

### Synopsis
Outputs objects as JSON

---

### Description

Outputs objects in JSON.

If only one object is outputted, it will not be in a list.
If multiple objects are outputted, they will be in a list.

---

### Related Links
* [@{
a = 'b'
} | Out-JSON](@{
a = 'b'
} | Out-JSON.md)

---

### Parameters
#### **InputObject**
The input object. This will form the majority of the JSON.

|Type |Required|Position|PipelineInput |
|------------|--------|--------|--------------|
|`[PSObject]`|false |named |true (ByValue)|

#### **ArgumentList**
Any arguments. These will be appended to the input.

|Type |Required|Position|PipelineInput|
|--------------|--------|--------|-------------|
|`[PSObject[]]`|false |named |false |

#### **Depth**
The depth of the JSON. By default, this is the FormatEnumerationLimit.

|Type |Required|Position|PipelineInput|
|---------|--------|--------|-------------|
|`[Int32]`|false |named |false |

---

### Syntax
```PowerShell
Out-JSON [-InputObject <PSObject>] [-ArgumentList <PSObject[]>] [-Depth <Int32>] [<CommonParameters>]
```

0 comments on commit 457064f

Please sign in to comment.