Register-HtmlRoute

August 3, 2026 ยท View on GitHub

SYNOPSIS

Cmdlet that registers a Playwright route handler for an active session.

SYNTAX

__AllParameterSets

Register-HtmlRoute [[-Session] <HtmlBrowserSession>] [-Pattern] <string> [-ScriptBlock] <scriptblock> [-CancellationToken <CancellationToken>] [<CommonParameters>]

DESCRIPTION

Cmdlet that registers a Playwright route handler for an active session.

EXAMPLES

EXAMPLE 1

Register-HtmlRoute -CancellationToken 'Value'

PARAMETERS

-CancellationToken

Token used to cancel the operation.

Type: CancellationToken
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-Pattern

URL pattern for the route.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-ScriptBlock

Script block executed for each matching request.

Type: ScriptBlock
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-Session

Browser session in use.

Type: HtmlBrowserSession
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: 0
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

  • HtmlTinkerX.HtmlBrowserSession

OUTPUTS

  • None
  • None