Skip to content

Commit

Permalink
Updated documentation for Include function
Browse files Browse the repository at this point in the history
  • Loading branch information
UberDoodles committed Apr 15, 2020
1 parent a4c4e40 commit c2a85bc
Showing 1 changed file with 34 additions and 5 deletions.
39 changes: 34 additions & 5 deletions docs/reference/functions/Include.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,14 @@ Include the functions or code of another powershell script file into the current

## SYNTAX

### Path (Default)
```
Include [-fileNamePathToInclude] <String> [<CommonParameters>]
Include [-Path] <String> [<CommonParameters>]
```

### LiteralPath
```
Include [-LiteralPath] <String> [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -46,20 +52,43 @@ The script above includes all the functions and variables defined in the ".\buil

Note: You can have more than 1 "Include" function defined in the build script.

### EXAMPLE 2
```
Strings or FileInfo objects can be piped to the Include function
```

@("File1.ps1","File2.ps1") | Include
Get-ChildItem | Include

## PARAMETERS

### -fileNamePathToInclude
A string containing the path and name of the powershell file to include
### -Path
A string containing the path and name of the powershell file to include (wildcards can be used)

```yaml
Type: String
Parameter Sets: Path
Aliases: fileNamePathToInclude

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: True
```

### -LiteralPath
A string containing the path and name of the powershell file to include (no wildcards)

```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: LiteralPath
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

Expand Down

0 comments on commit c2a85bc

Please sign in to comment.