Skip to content

Add-PublicFunction.md

Latest commit

 

History

History
85 lines (62 loc) · 1.45 KB

Add-PublicFunction.md

File metadata and controls

85 lines (62 loc) · 1.45 KB
Raw

external help file: ModuleBuild-help.xml online version: https://github.com/zloeber/ModuleBuild schema: 2.0.0

Add-PublicFunction

SYNOPSIS

Adds a public function to your modulebuild based project based on defined templates.

SYNTAX

Add-PublicFunction [[-Name] <String>] [-Force] [-TemplateName <String>]

DESCRIPTION

Adds a public function to your modulebuild based project.

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

Add-PublicFunction -Name 'New-AwesomeFunction' -Template:PlainPublicFunction

PARAMETERS

-Name

Name of the function to add. Must use a valid PowerShell verb-action format and be singular.

Type: String
Parameter Sets: (All)
Aliases: 

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

-Force

Ignore function name best practices warnings.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-TemplateName

Use this template file for the new function

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

OUTPUTS

NOTES

RELATED LINKS

https://github.com/zloeber/ModuleBuild