Save-HtmlBrowserAttachment

August 3, 2026 ยท View on GitHub

SYNOPSIS

Cmdlet that saves files downloaded while rendering a web page.

SYNTAX

Default (Default)

Save-HtmlBrowserAttachment [-Url] <string> -Path <string> [-Browser <HtmlBrowserEngine>] [-Clean] [-Visible] [-SlowMo <int>] [-Filter <string>] [-CancellationToken <CancellationToken>] [<CommonParameters>]

Session

Save-HtmlBrowserAttachment [[-Session] <HtmlBrowserSession>] -Path <string> [-SlowMo <int>] [-Filter <string>] [-CancellationToken <CancellationToken>] [<CommonParameters>]

DESCRIPTION

Cmdlet that saves files downloaded while rendering a web page.

EXAMPLES

EXAMPLE 1

Save-HTMLAttachment -Url https://example.com/download.html -Path C:\temp

PARAMETERS

-Browser

Browser engine to use for rendering.

Type: HtmlBrowserEngine
Parameter Sets: Default
Aliases: None
Possible values: Chromium, Firefox, WebKit

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

-CancellationToken

Token used to cancel the operation.

Type: CancellationToken
Parameter Sets: Default, Session
Aliases: None
Possible values:

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

-Clean

Force re-download of browser runtimes.

Type: SwitchParameter
Parameter Sets: Default
Aliases: None
Possible values:

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

-Filter

Optional filter applied to download URLs or file names.

Type: String
Parameter Sets: Default, Session
Aliases: None
Possible values:

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

-Path

Directory where downloads will be saved.

Type: String
Parameter Sets: Default, Session
Aliases: File
Possible values:

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

-Session

Existing browser session.

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

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

-SlowMo

Slow down Playwright actions by the specified milliseconds.

Type: Int32
Parameter Sets: Default, Session
Aliases: None
Possible values:

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

-Url

URL of the web page.

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

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

-Visible

Show the browser instead of running headless.

Type: SwitchParameter
Parameter Sets: Default
Aliases: None
Possible values:

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

  • HtmlTinkerX.HtmlBrowserSession

OUTPUTS

  • System.String
  • None