Skip to content

Test-PodeSseEvent

SYNOPSIS

Test if one or more SSE events are registered.

SYNTAX

Test-PodeSseEvent [[-Name] <String[]>] [-Type] <PodeClientConnectionEventType[]> [[-EventName] <String[]>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Test if one or more SSE events are registered.

EXAMPLES

EXAMPLE 1

if (Test-PodeSseEvent -Name 'Actions' -Type Connect -EventName 'OnConnect') { ... }

EXAMPLE 2

if (Test-PodeSseEvent -Type Disconnect) { ... }

PARAMETERS

-EventName

An optional name(s) of the event to test.

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

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

-Name

An optional Name(s) of the SSE connection(s) to test.

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

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

-Type

The Type(s) of event to test, either Connect or Disconnect.

Type: PodeClientConnectionEventType[]
Parameter Sets: (All)
Aliases:
Accepted values: Connect, Disconnect

Required: True
Position: 2
Default value: None
Accept pipeline input: False
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

System.Boolean

NOTES