Logo Paket

NuGet Module

Types and nested modules

Type/Module Description

NuGetContent (Module)

GetVersionError

GetVersionRequest

GetVersionRequestResult

NuGetContent (Type)

NuGetPackageCache

NuGetPackageContent

SourceRequest

SourceResponse

SourceResponseType

UnparsedPackageFile

Functions and values

Function or value Description

DownloadAndExtractPackage (alternativeProjectRoot, root, isLocalOverride, config, source, caches, groupName, packageName, version, kind, includeVersionInPath, downloadLicense, force, detailed)

Full Usage: DownloadAndExtractPackage (alternativeProjectRoot, root, isLocalOverride, config, source, caches, groupName, packageName, version, kind, includeVersionInPath, downloadLicense, force, detailed)

Parameters:
Returns: Async<string * string>
alternativeProjectRoot : string option
root : string
isLocalOverride : bool
config : PackagesFolderGroupConfig
source : PackageSource
caches : Cache list
groupName : GroupName
packageName : PackageName
version : SemVerInfo
kind : ResolvedPackageKind
includeVersionInPath : bool
downloadLicense : bool
force : bool
detailed : bool
Returns: Async<string * string>

DownloadLicense (root, force, packageName, version, licenseUrl, targetFileName)

Full Usage: DownloadLicense (root, force, packageName, version, licenseUrl, targetFileName)

Parameters:
    root : 'a
    force : bool
    packageName : PackageName
    version : SemVerInfo
    licenseUrl : string
    targetFileName : string

Returns: Async<unit>
Type parameters: 'a
root : 'a
force : bool
packageName : PackageName
version : SemVerInfo
licenseUrl : string
targetFileName : string
Returns: Async<unit>

GetContent dir

Full Usage: GetContent dir

Parameters:
    dir : string

Returns: Lazy<NuGetPackageContent>
dir : string
Returns: Lazy<NuGetPackageContent>

GetContentWithNuSpec spec dir

Full Usage: GetContentWithNuSpec spec dir

Parameters:
Returns: Lazy<NuGetPackageContent>
spec : Nuspec
dir : string
Returns: Lazy<NuGetPackageContent>

GetPackageDetails alternativeProjectRoot root force parameters

Full Usage: GetPackageDetails alternativeProjectRoot root force parameters

Parameters:
Returns: Async<PackageDetails>
alternativeProjectRoot : string option
root : string
force : bool
parameters : GetPackageDetailsParameters
Returns: Async<PackageDetails>

GetVersions force alternativeProjectRoot root parameters

Full Usage: GetVersions force alternativeProjectRoot root parameters

Parameters:
Returns: Async<(SemVerInfo * PackageSource list) list>

Allows to retrieve all version no. for a package from the given sources.

force : bool
alternativeProjectRoot : string option
root : string
parameters : GetPackageVersionsParameters
Returns: Async<(SemVerInfo * PackageSource list) list>

addContent content contents

Full Usage: addContent content contents

Parameters:
Returns: NuGetContent list
content : string
contents : NuGetContent list
Returns: NuGetContent list

createEntry content

Full Usage: createEntry content

Parameters:
    content : string

Returns: NuGetContent
content : string
Returns: NuGetContent

getVersionsCached key f (source, auth, nugetURL, package)

Full Usage: getVersionsCached key f (source, auth, nugetURL, package)

Parameters:
Returns: NuGetRequestGetVersions
Type parameters: 'a, 'b, 'c
key : string
f : 'a * 'b * 'c -> NuGetRequestGetVersions
source : PackageSource
auth : 'a
nugetURL : 'b
package : 'c
Returns: NuGetRequestGetVersions

ofDirectory targetFolder

Full Usage: ofDirectory targetFolder

Parameters:
    targetFolder : string

Returns: NuGetContent
targetFolder : string
Returns: NuGetContent

ofFiles filesList

Full Usage: ofFiles filesList

Parameters:
    filesList : string seq

Returns: NuGetContent list
filesList : string seq
Returns: NuGetContent list

ofGivenList rootName directories files

Full Usage: ofGivenList rootName directories files

Parameters:
    rootName : string
    directories : string seq
    files : string seq

Returns: NuGetContent
Modifiers: inline
rootName : string
directories : string seq
files : string seq
Returns: NuGetContent

protocolCache

Full Usage: protocolCache

Returns: ConcurrentDictionary<PackageSource, string>

tryFindFile file content

Full Usage: tryFindFile file content

Parameters:
Returns: UnparsedPackageFile option
file : string
content : NuGetPackageContent
Returns: UnparsedPackageFile option

tryFindFolder folder content

Full Usage: tryFindFolder folder content

Parameters:
Returns: UnparsedPackageFile list option
folder : string
content : NuGetPackageContent
Returns: UnparsedPackageFile list option

tryNuGetV3 (auth, nugetV3Url, package)

Full Usage: tryNuGetV3 (auth, nugetV3Url, package)

Parameters:
Returns: NuGetRequestGetVersions
auth : AuthProvider
nugetV3Url : string
package : PackageName
Returns: NuGetRequestGetVersions

tryNugetV3Search (auth, nugetV3Url, package)

Full Usage: tryNugetV3Search (auth, nugetV3Url, package)

Parameters:
Returns: NuGetRequestGetVersions
Type parameters: 'a
auth : AuthProvider
nugetV3Url : 'a
package : PackageName
Returns: NuGetRequestGetVersions

Type something to start searching.