DownloadParams (Fake)

DocFx.DownloadParams Type

Namespace: Fake.Documentation
Assembly: Fake.Documentation.DocFx.dll
Parent Module: DocFx
Base Type: obj
All Interfaces: IEquatable<DownloadParams> , IStructuralEquatable , IComparable<DownloadParams> , IComparable , IStructuralComparable

Download-Command parameters

Record Field	Description
`ArchiveFile` Full Usage: `ArchiveFile` Field type: `string`	Specify the output xref archive. Field type: `string`
`Common` Full Usage: `Common` Field type: `CommonParams`	Specify common docFx options Field type: `CommonParams`
`Uri` Full Usage: `Uri` Field type: `string`	Specify the url of xrefmap. Field type: `string`

Instance member Description

Instance member	Description
`this.WithCommon` Full Usage: `this.WithCommon` Parameters: f : `CommonParams -> CommonParams` Returns: `DownloadParams` Modifiers: inline	Changes the "Common" parameters according to the given function f : `CommonParams -> CommonParams` Returns: `DownloadParams`


                
                  
                    
                      this.WithCommon

Full Usage: this.WithCommon

Parameters:

f : CommonParams -> CommonParams

Returns: DownloadParams
Modifiers: inline

Changes the "Common" parameters according to the given function

Static member	Description
`DownloadParams.Create()` Full Usage: `DownloadParams.Create()` Returns: `DownloadParams`	Download default parameters Returns: `DownloadParams`