Logo Paket

NuGetV3 Module

Contains NuGet support.

Types

Type Description

Catalog

CatalogDependency

CatalogDependencyGroup

NugetV3CatalogIndexItem

NugetV3CatalogPage

NugetV3CatalogPageItem

large unused fields are commented-out

NugetV3PackageCatalog

NugetV3ResourceType

NugetV3SourceResourceJSON

NugetV3SourceRootJSON

PackageIndex

PackageIndexPackage

PackageIndexPage

ResourceIndex

Functions and values

Function or value Description

FindAutoCompleteVersionsForPackage (nugetURL, auth, package, includingPrereleases, maxResults)

Full Usage: FindAutoCompleteVersionsForPackage (nugetURL, auth, package, includingPrereleases, maxResults)

Parameters:
Returns: Async<SafeWebResult<string array>>

Uses the NuGet v3 autocomplete service to retrieve all package versions for the given package.

nugetURL : string
auth : AuthProvider
package : PackageName
includingPrereleases : bool
maxResults : int
Returns: Async<SafeWebResult<string array>>

FindPackages (auth, nugetURL, packageNamePrefix, maxResults)

Full Usage: FindPackages (auth, nugetURL, packageNamePrefix, maxResults)

Parameters:
    auth : AuthProvider
    nugetURL : string
    packageNamePrefix : string
    maxResults : int

Returns: Async<Result<string[], ExceptionDispatchInfo>>

Uses the NuGet v3 autocomplete service to retrieve all packages with the given prefix.

auth : AuthProvider
nugetURL : string
packageNamePrefix : string
maxResults : int
Returns: Async<Result<string[], ExceptionDispatchInfo>>

FindVersionsForPackage (nugetURL, auth, package)

Full Usage: FindVersionsForPackage (nugetURL, auth, package)

Parameters:
Returns: NuGetRequestGetVersions

Uses the NuGet v3 service to retrieve all package versions for the given package.

nugetURL : string
auth : AuthProvider
package : PackageName
Returns: NuGetRequestGetVersions

GetPackageDetails force source packageName version

Full Usage: GetPackageDetails force source packageName version

Parameters:
Returns: Async<ODataSearchResult>

Uses the NuGet v3 registration endpoint to retrieve package details .

force : bool
source : NuGetV3Source
packageName : PackageName
version : SemVerInfo
Returns: Async<ODataSearchResult>

calculateNuGet2Path nugetUrl

Full Usage: calculateNuGet2Path nugetUrl

Parameters:
    nugetUrl : string

Returns: string option

Calculates the NuGet v3 URL from a NuGet v2 URL.

nugetUrl : string
Returns: string option

calculateNuGet3Path nugetUrl

Full Usage: calculateNuGet3Path nugetUrl

Parameters:
    nugetUrl : string

Returns: string option

Calculates the NuGet v3 URL from a NuGet v2 URL.

nugetUrl : string
Returns: string option

catalogSemVer2ordered catalog

Full Usage: catalogSemVer2ordered catalog

Parameters:
Returns: NugetV3PackageCatalog

extractSearchVersion response

Full Usage: extractSearchVersion response

Parameters:
    response : string

Returns: JSONSearchData
response : string
Returns: JSONSearchData

getCatalogCursor basePath serviceUrl

Full Usage: getCatalogCursor basePath serviceUrl

Parameters:
    basePath : string
    serviceUrl : string

Returns: NugetV3PackageCatalog
basePath : string
serviceUrl : string
Returns: NugetV3PackageCatalog

getNuGetV3Resource source resourceType

Full Usage: getNuGetV3Resource source resourceType

Parameters:
Returns: Async<string>
source : NuGetV3Source
resourceType : NugetV3ResourceType
Returns: Async<string>

getPackageDetails source packageName version

Full Usage: getPackageDetails source packageName version

Parameters:
Returns: Async<ODataSearchResult>
source : NuGetV3Source
packageName : PackageName
version : SemVerInfo
Returns: Async<ODataSearchResult>

getPackageIndex source packageName

Full Usage: getPackageIndex source packageName

Parameters:
Returns: Async<PackageIndex option>
source : NuGetV3Source
packageName : PackageName
Returns: Async<PackageIndex option>

getPackageIndexPage source page

Full Usage: getPackageIndexPage source page

Parameters:
Returns: Async<PackageIndexPage>

getRelevantPage source index version

Full Usage: getRelevantPage source index version

Parameters:
Returns: Async<PackageIndexPackage option>
source : NuGetV3Source
index : PackageIndex
version : SemVerInfo
Returns: Async<PackageIndexPackage option>

setCatalogCursor basePath catalog

Full Usage: setCatalogCursor basePath catalog

Parameters:
Returns: bool
basePath : string
catalog : NugetV3PackageCatalog
Returns: bool

tryGetNuGetV3Resource source resourceType

Full Usage: tryGetNuGetV3Resource source resourceType

Parameters:
Returns: Async<string option>
source : NuGetV3Source
resourceType : NugetV3ResourceType
Returns: Async<string option>

Type something to start searching.