Skip to content

New-PodeMiddleware

SYNOPSIS

Creates a new Middleware HashTable object, that can be piped/used in Add-PodeMiddleware or in Routes.

SYNTAX

New-PodeMiddleware [-ScriptBlock] <ScriptBlock> [[-Route] <String>] [[-ArgumentList] <Object[]>]
 [<CommonParameters>]

DESCRIPTION

Creates a new Middleware HashTable object, that can be piped/used in Add-PodeMiddleware or in Routes. ScriptBlock should return $true to continue execution, or $false to stop.

EXAMPLES

EXAMPLE 1

New-PodeMiddleware -ScriptBlock { /* logic */ } -ArgumentList 'Email' | Add-PodeMiddleware -Name 'CheckEmail'

PARAMETERS

-ArgumentList

An array of arguments to supply to the Middleware's ScriptBlock.

Type: Object[]
Parameter Sets: (All)
Aliases:

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

-Route

A Route path for which Routes this Middleware should only be invoked against.

Type: String
Parameter Sets: (All)
Aliases:

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

-ScriptBlock

The Script that defines the logic of the Middleware. Should return $true to continue execution, or $false to stop.

Type: ScriptBlock
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Boolean. ScriptBlock should return $true to continue to the next middleware/route, or return $false to stop execution.

NOTES

Back to top