Logo Paket

NuGetCache Module

Contains NuGet cache support.

Types and nested modules

Type/Module Description

NuGetConfig

ODataSearchResult (Module)

BlockedCacheEntry

FrameworkRestrictionsCache

GetVersionFilter

NuGetPackageCache

NuGetRequestGetVersions

NuGetResponseGetVersions

NuGetResponseGetVersionsFailure

NuGetResponseGetVersionsSimple

NuGetResponseGetVersionsSuccess

ODataSearchResult (Type)

QueryResult

SendDataModification

UnparsedPackageFile

UrlId

UrlToTry

Functions and values

Function or value Description

CopyFromCache (config, cacheFileName, licenseCacheFile, packageName, version, force, detailed)

Full Usage: CopyFromCache (config, cacheFileName, licenseCacheFile, packageName, version, force, detailed)

Parameters:
Returns: Async<string option>

Extracts the given package to the ./packages folder

config : ResolvedPackagesFolder
cacheFileName : string
licenseCacheFile : string
packageName : PackageName
version : SemVerInfo
force : bool
detailed : bool
Returns: Async<string option>

CopyLicenseFromCache (config, cacheFileName, packageName, version, force)

Full Usage: CopyLicenseFromCache (config, cacheFileName, packageName, version, force)

Parameters:
Returns: Async<unit>
config : ResolvedPackagesFolder
cacheFileName : string
packageName : PackageName
version : SemVerInfo
force : bool
Returns: Async<unit>

CopyToCache (cache, fileName, force)

Full Usage: CopyToCache (cache, fileName, force)

Parameters:
    cache : Cache
    fileName : string
    force : bool

Puts the package into the cache

cache : Cache
fileName : string
force : bool

ExtractPackage (fileName, targetFolder, packageName, version, detailed)

Full Usage: ExtractPackage (fileName, targetFolder, packageName, version, detailed)

Parameters:
Returns: Async<string>

Extracts the given package to the ./packages folder

fileName : string
targetFolder : string
packageName : PackageName
version : SemVerInfo
detailed : bool
Returns: Async<string>

ExtractPackageToUserFolder (source, downloadedNupkgPath, packageName, version, kind)

Full Usage: ExtractPackageToUserFolder (source, downloadedNupkgPath, packageName, version, kind)

Parameters:
Returns: Async<string>

Extracts the given package to the user folder

source : PackageSource
downloadedNupkgPath : string
packageName : PackageName
version : SemVerInfo
kind : ResolvedPackageKind
Returns: Async<string>

FileInfo str

Full Usage: FileInfo str

Parameters:
    str : string

Returns: FileInfo
str : string
Returns: FileInfo

GetLicenseFileName packageName version

Full Usage: GetLicenseFileName packageName version

Parameters:
Returns: string
packageName : PackageName
version : SemVerInfo
Returns: string

GetPackageFileName packageName version

Full Usage: GetPackageFileName packageName version

Parameters:
Returns: string
packageName : PackageName
version : SemVerInfo
Returns: string

GetPackageUserFolderDir (packageName, version, kind)

Full Usage: GetPackageUserFolderDir (packageName, version, kind)

Parameters:
Returns: string
packageName : PackageName
version : SemVerInfo
kind : ResolvedPackageKind
Returns: string

GetTargetUserFolder packageName version

Full Usage: GetTargetUserFolder packageName version

Parameters:
Returns: string
packageName : PackageName
version : SemVerInfo
Returns: string

GetTargetUserNupkg packageName version

Full Usage: GetTargetUserNupkg packageName version

Parameters:
Returns: string
packageName : PackageName
version : SemVerInfo
Returns: string

GetTargetUserToolsFolder packageName version

Full Usage: GetTargetUserToolsFolder packageName version

Parameters:
Returns: string
packageName : PackageName
version : SemVerInfo
Returns: string

IsPackageVersionExtracted (config, packageName, version)

Full Usage: IsPackageVersionExtracted (config, packageName, version)

Parameters:
Returns: bool
config : ResolvedPackagesFolder
packageName : PackageName
version : SemVerInfo
Returns: bool

TryGetFallbackFolder ()

Full Usage: TryGetFallbackFolder ()

Parameters:
    () : unit

Returns: string option
() : unit
Returns: string option

TryGetFallbackFolderFromBin ()

Full Usage: TryGetFallbackFolderFromBin ()

Parameters:
    () : unit

Returns: string option
() : unit
Returns: string option

TryGetFallbackFolderFromHardCodedPath

Full Usage: TryGetFallbackFolderFromHardCodedPath

Returns: Lazy<string option>
Returns: Lazy<string option>

TryGetFallbackNupkg packageName version

Full Usage: TryGetFallbackNupkg packageName version

Parameters:
Returns: string option
packageName : PackageName
version : SemVerInfo
Returns: string option

getCacheDataFromExtractedPackage packageName version

Full Usage: getCacheDataFromExtractedPackage packageName version

Parameters:
Returns: Async<NuGetPackageCache option>
packageName : PackageName
version : SemVerInfo
Returns: Async<NuGetPackageCache option>

getCacheFiles force cacheVersion nugetURL packageName version

Full Usage: getCacheFiles force cacheVersion nugetURL packageName version

Parameters:
Returns: FileInfo
force : bool
cacheVersion : string
nugetURL : string
packageName : PackageName
version : SemVerInfo
Returns: FileInfo

getDetailsFromCacheOr force nugetURL packageName version getViaWebRequest

Full Usage: getDetailsFromCacheOr force nugetURL packageName version getViaWebRequest

Parameters:
Returns: Async<ODataSearchResult>
force : bool
nugetURL : string
packageName : PackageName
version : SemVerInfo
getViaWebRequest : unit -> Async<ODataSearchResult>
Returns: Async<ODataSearchResult>

getNuSpecFromNupkg fileName

Full Usage: getNuSpecFromNupkg fileName

Parameters:
    fileName : string

Returns: Nuspec

Reads nuspec from nupkg

fileName : string
Returns: Nuspec

isExtracted directory packageName version

Full Usage: isExtracted directory packageName version

Parameters:
Returns: bool
Modifiers: inline
directory : DirectoryInfo
packageName : PackageName
version : SemVerInfo
Returns: bool

normalizeUrl url

Full Usage: normalizeUrl url

Parameters:
    url : string

Returns: string
Modifiers: inline
url : string
Returns: string

parsePackageInfoFromFileName fileName

Full Usage: parsePackageInfoFromFileName fileName

Parameters:
    fileName : string

Returns: (PackageName * SemVerInfo) option

Reads packageName and version from .nupkg file name

fileName : string
Returns: (PackageName * SemVerInfo) option

tryAndIgnoreUrl doIgnore doWarn source tryAgain f urls

Full Usage: tryAndIgnoreUrl doIgnore doWarn source tryAgain f urls

Parameters:
Returns: Async<QueryResult>
doIgnore : bool
doWarn : bool
source : NuGetSource
tryAgain : QueryResult -> bool
f : string -> Async<QueryResult>
urls : UrlToTry list
Returns: Async<QueryResult>

tryFindLocalPackage directory packageName version

Full Usage: tryFindLocalPackage directory packageName version

Parameters:
Returns: FileInfo option
directory : string
packageName : PackageName
version : SemVerInfo
Returns: FileInfo option

tryGetDetailsFromCache force nugetURL packageName version

Full Usage: tryGetDetailsFromCache force nugetURL packageName version

Parameters:
Returns: ODataSearchResult option
force : bool
nugetURL : string
packageName : PackageName
version : SemVerInfo
Returns: ODataSearchResult option

Type something to start searching.